Webservices VoicePlan

VoiceCheck geeft een webservice weer waarin u een VoicePlan kunt maken—in wezen een gegevensimport. Deze webservice maakt het zowel mogelijk om nieuwe VoicePlans te maken als bestaande VoicePlans bij te werken of te verwijderen van de VoiceCheck-server. Als deze webservice wordt opgeroepen controleert VoiceCheck het systeem op het volgende:

  • Als er geen overeenkomende VoicePlan-naam is, wordt er een nieuw VoicePlan gemaakt.
  • Als er een overeenkomende VoicePlan-naam bestaat, wordt er geen nieuw VoicePlan gemaakt.
  • Een VoicePlan zonder beschrijving, VoiceForm en sectiestappen wordt als ongeldig beschouwd en niet gemaakt.
  • Een VoicePlan wordt niet gemaakt als het VoiceForm dat aan het VoicePlan is gekoppeld niet wordt gevonden in de VoiceCheck-server.

Wanneer VoiceCheck dit bericht ontvangt voor lezen, bijwerken en verwijderen van VoicePlans, worden de volgende validaties in acht genomen:

  • Als de VoicePlan-naam niet bestaat in VoiceCheck, worden er geen details geretourneerd in de reactie.
  • Als het VoicePlan wel bestaat, kan de webservice alleen de naam van het VoicePlan bijwerken.
  • Een VoicePlan kan worden verwijderd, zelfs als het verwijst naar een van de entiteiten in VoiceCheck.

Details VoicePlan maken

REST-webservice

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan

Methode: POST

Type content: application/json;charset=UTF-8

Berichttekst: JSON zoals omschreven in het schema in de WADL. De elementen worden beschreven in de tabel Invoer elementen.

Reactie: Bij succes HTTP-status 200 met nettolading “VoicePlan opgeslagen”. Bij mislukking retourneert het systeem een foutmelding. Elke andere HTTP-statuscode dan 200 of 204 wordt als fout beschouwd. Indien mogelijk moet het hostsysteem een tekst voor fouten retourneren.

POST-parameters

Een VoicePlan-bestand met geldige parameters in de tekst.

DETAILS VOICEPLAN LEZEN

REST-WEBSERVICE

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan/{planIdentifier}

Methode: GET

Type content: application/json;charset=UTF-8

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

DETAILS VOICEPLAN BIJWERKEN

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan/update/

Methode: POST

Type content: application/json;charset=UTF-8

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

POST-parameters

Een VoicePlan-bestand met bijgewerkte parameters in de tekst.

DETAILS VOICEPLAN VERWIJDEREN

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceplan/{planIdentifier}

Methode: VERWIJDEREN

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

INVOER ELEMENTEN

EIGENSCHAP TYPE VERPLICHT DEFINITIE VALIDATIE
planIdentifier

Tekenreeks

Ja De naam van het VoicePlan Moet uniek zijn in VoiceCheck